-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
traffic.json
1173 lines (1173 loc) · 45.4 KB
/
traffic.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"swagger": "2.0",
"info": {
"title": "Azure Maps Traffic Service",
"version": "1.0",
"description": "Azure Maps Traffic REST APIs"
},
"host": "atlas.microsoft.com",
"schemes": [
"https"
],
"consumes": [],
"produces": [
"application/json",
"application/xml"
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.",
"scopes": {
"user_impersonation": "Impersonates a user's Azure Active Directory account."
}
},
"apiKeyQuery": {
"type": "apiKey",
"description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.",
"name": "subscription-key",
"in": "query"
}
},
"security": [
{
"azure_auth": []
},
{
"apiKeyQuery": []
}
],
"responses": {
"202": {
"description": "Request Accepted: The request has been accepted for processing. Please use the URL in the Location Header to retry or access the results.",
"headers": {
"Location": {
"type": "string",
"description": "New URL to check for the results of the long running process."
}
}
},
"400": {
"description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.",
"schema": {
"$ref": "#/definitions/ODataErrorResponse"
}
},
"401": {
"description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.",
"schema": {
"$ref": "#/definitions/ODataErrorResponse"
},
"headers": {
"WWW-Authenticate": {
"type": "string",
"description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\""
}
}
},
"403": {
"description": "Permission, capacity, or authentication issues.",
"schema": {
"$ref": "#/definitions/ODataErrorResponse"
}
},
"404": {
"description": "Not Found: the requested resource could not be found, but it may be available again in the future.",
"schema": {
"$ref": "#/definitions/ODataErrorResponse"
}
},
"500": {
"description": "An error occurred while processing the request. Please try again later.",
"schema": {
"$ref": "#/definitions/ODataErrorResponse"
}
}
},
"parameters": {
"ClientId": {
"name": "x-ms-client-id",
"description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.",
"type": "string",
"in": "header",
"required": false,
"x-ms-parameter-location": "client"
},
"SubscriptionKey": {
"name": "subscription-key",
"description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.",
"type": "string",
"in": "query",
"required": false,
"x-ms-parameter-location": "client"
},
"ApiVersion": {
"name": "api-version",
"description": "Version number of Azure Maps API. Current version is 1.0",
"type": "string",
"in": "query",
"required": true,
"default": "1.0",
"x-ms-parameter-location": "client"
},
"JsonFormat": {
"name": "format",
"description": "Desired format of the response. Only `json` format is supported.",
"type": "string",
"in": "path",
"required": true,
"enum": [
"json"
],
"x-ms-enum": {
"name": "JsonFormat",
"modelAsString": true,
"values": [
{
"value": "json",
"description": "[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)"
}
]
},
"x-ms-parameter-location": "method"
},
"TextFormat": {
"name": "format",
"description": "Desired format of the response. Value can be either _json_ or _xml_.",
"type": "string",
"in": "path",
"required": true,
"enum": [
"json",
"xml"
],
"x-ms-enum": {
"name": "TextFormat",
"modelAsString": true,
"values": [
{
"value": "json",
"description": "[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)"
},
{
"value": "xml",
"description": "[The Extensible Markup Language](https://www.w3.org/TR/xml/)"
}
]
},
"x-ms-parameter-location": "method"
},
"RasterTileFormat": {
"name": "format",
"description": "Desired format of the response. Possible value: png.",
"type": "string",
"in": "path",
"required": true,
"enum": [
"png"
],
"x-ms-enum": {
"name": "RasterTileFormat",
"modelAsString": true,
"values": [
{
"value": "png",
"description": "An image in the png format. Supports zoom levels 0 through 18."
}
]
},
"x-ms-parameter-location": "method"
},
"TileFormat": {
"name": "format",
"description": "Desired format of the response. Possible values are png & pbf.",
"type": "string",
"in": "path",
"required": true,
"enum": [
"png",
"pbf"
],
"x-ms-enum": {
"name": "TileFormat",
"modelAsString": true,
"values": [
{
"value": "png",
"description": "An image in the png format. Supports zoom levels 0 through 18."
},
{
"value": "pbf",
"description": "Vector graphic in the pbf format. Supports zoom levels 0 through 22."
}
]
},
"x-ms-parameter-location": "method"
},
"RasterZoom": {
"name": "zoom",
"in": "query",
"description": "Zoom level for the desired tile. Zoom value must be in the range: 0-22 (inclusive).\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.",
"required": true,
"type": "integer",
"format": "int32",
"x-ms-parameter-location": "method"
},
"RasterVectorZoom": {
"name": "zoom",
"in": "query",
"description": "Zoom level for the desired tile. For _raster_ tiles, value must be in the range: 0-22 (inclusive). For _vector_ tiles, value must be in the range: 0-22 (inclusive).\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.",
"required": true,
"type": "integer",
"format": "int32",
"x-ms-parameter-location": "method"
},
"xTileIndex": {
"name": "x",
"x-ms-client-name": "xTileIndex",
"in": "query",
"description": "X coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>`zoom`</sup> -1].\n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.",
"required": true,
"type": "integer",
"format": "int32",
"x-ms-parameter-location": "method"
},
"yTileIndex": {
"name": "y",
"x-ms-client-name": "yTileIndex",
"in": "query",
"description": "Y coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>`zoom`</sup> -1].\n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.",
"required": true,
"type": "integer",
"format": "int32",
"x-ms-parameter-location": "method"
}
},
"paths": {
"/traffic/flow/tile/{format}": {
"get": {
"x-publish": true,
"description": "__Traffic Flow Tile__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\nThe Azure Flow Tile API serves 256 x 256 pixel tiles showing traffic flow. All tiles use the same grid system. Because the traffic tiles use transparent images, they can be layered on top of map tiles to create a compound display. The Flow tiles use colors to indicate either the speed of traffic on different road segments, or the difference between that speed and the free-flow speed on the road segment in question.",
"operationId": "Traffic_GetTrafficFlowTile",
"x-ms-examples": {
"GetTrafficFlowTile": {
"$ref": "./examples/GetTrafficFlowTile.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ClientId"
},
{
"$ref": "#/parameters/SubscriptionKey"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/TileFormat"
},
{
"name": "style",
"in": "query",
"description": "<p>The style to be used to render the tile.</p>",
"required": true,
"type": "string",
"enum": [
"absolute",
"relative",
"relative-delay",
"reduced-sensitivity"
],
"x-ms-enum": {
"name": "TrafficFlowTileStyle",
"modelAsString": true,
"values": [
{
"value": "absolute",
"description": "Colors will reflect the absolute speed measured. Absolute speed is the capability to access the full speed."
},
{
"value": "relative",
"description": "This is the speed relative to free-flow, highlighting areas of congestion visualizing the traffic flow. Free-flow refers to conditions where there is no congestion and traffic can follow the speed limits. The most used option to visualize traffic flow on a map."
},
{
"value": "relative-delay",
"description": "Displays relative colors only where they are different from the free-flow speeds. This option will only highlights areas of congestion."
},
{
"value": "reduced-sensitivity",
"description": "Displays relative colors but a larger difference from freeflow is required for segments to change the color. This mode only valid when format is png."
}
]
}
},
{
"$ref": "#/parameters/RasterVectorZoom"
},
{
"$ref": "#/parameters/xTileIndex"
},
{
"$ref": "#/parameters/yTileIndex"
},
{
"name": "thickness",
"in": "query",
"description": "The value of the width of the line representing traffic. This value is a multiplier and the accepted values range from 1 - 20. The default value is 10. This parameter is not valid when format is pbf.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 20,
"default": 10
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrafficFlowTileResult"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"500": {
"$ref": "#/responses/500"
}
},
"produces": [
"application/json"
]
}
},
"/traffic/flow/segment/{format}": {
"get": {
"x-publish": true,
"description": "__Traffic Flow Segment__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\nThis service provides information about the speeds and travel times of the road fragment closest to the given coordinates. It is designed to work alongside the Flow layer of the Render Service to support clickable flow data visualizations. With this API, the client side can connect any place in the map with flow data on the closest road and present it to the user.",
"operationId": "Traffic_GetTrafficFlowSegment",
"x-ms-examples": {
"GetTrafficFlowSegment": {
"$ref": "./examples/GetTrafficFlowSegment.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ClientId"
},
{
"$ref": "#/parameters/SubscriptionKey"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/TextFormat"
},
{
"name": "style",
"in": "query",
"description": "The style to be used to render the tile. Valid values are absolute which returns colors reflecting the absolute speed measured, relative which returns the speed relative to free-flow, Relative-delay which displays relative speeds only where they are different from the freeflow speeds",
"required": true,
"type": "string",
"enum": [
"absolute",
"relative",
"relative-delay"
],
"x-ms-enum": {
"name": "TrafficFlowSegmentStyle",
"modelAsString": true
}
},
{
"$ref": "#/parameters/RasterZoom"
},
{
"name": "query",
"in": "query",
"description": "Coordinates of the point close to the road segment. They have to be comma-separated and calculated using EPSG4326 projection.",
"required": true,
"type": "string"
},
{
"name": "unit",
"in": "query",
"description": "Unit of speed in KMPH or MPH",
"required": false,
"type": "string",
"default": "KMPH",
"enum": [
"KMPH",
"MPH"
],
"x-ms-enum": {
"name": "SpeedUnit",
"modelAsString": true,
"values": [
{
"value": "KMPH",
"description": "Kilometers Per Hour"
},
{
"value": "MPH",
"description": "Miles Per Hour"
}
]
}
},
{
"name": "thickness",
"in": "query",
"description": "The value of the width of the line representing traffic. This value is a multiplier and the accepted values range from 1 - 20. The default value is 10.",
"required": false,
"type": "integer",
"format": "int32",
"default": 10,
"minimum": 1,
"maximum": 20
},
{
"name": "openLr",
"in": "query",
"description": "Boolean on whether the response should include OpenLR code",
"required": false,
"type": "boolean",
"default": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrafficFlowSegmentResult"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"500": {
"$ref": "#/responses/500"
}
}
}
},
"/traffic/incident/tile/{format}": {
"get": {
"x-publish": true,
"description": "__Traffic Incident Tile__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\nThis service serves 256 x 256 pixel tiles showing traffic incidents. All tiles use the same grid system. Because the traffic tiles use transparent images, they can be layered on top of map tiles to create a compound display. Traffic tiles render graphics to indicate traffic on the roads in the specified area.",
"operationId": "Traffic_GetTrafficIncidentTile",
"x-ms-examples": {
"GetTrafficIncidentTile": {
"$ref": "./examples/GetTrafficIncidentTile.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ClientId"
},
{
"$ref": "#/parameters/SubscriptionKey"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/TileFormat"
},
{
"name": "style",
"in": "query",
"description": "The style to be used to render the tile. This parameter is not valid when format is pbf.",
"required": true,
"type": "string",
"enum": [
"s1",
"s2",
"s3",
"night"
],
"x-ms-enum": {
"name": "TrafficIncidentTileStyle",
"modelAsString": true,
"values": [
{
"value": "s1",
"description": "Creates traffic lines with colored chevrons indicating severity."
},
{
"value": "s2",
"description": "Creates plain lines with certain degree of glow."
},
{
"value": "s3",
"description": "Creates plain lines with certain degree of glow."
},
{
"value": "night",
"description": "Night style."
}
]
}
},
{
"$ref": "#/parameters/RasterVectorZoom"
},
{
"$ref": "#/parameters/xTileIndex"
},
{
"$ref": "#/parameters/yTileIndex"
},
{
"name": "t",
"x-ms-client-name": "trafficState",
"in": "query",
"description": "Reference value for the state of traffic at a particular time, obtained from the Viewport API call, trafficModelId attribute in trafficState field. It is updated every minute, and is valid for two minutes before it times out. Use -1 to get the most recent traffic information. Default: most recent traffic information.",
"required": false,
"type": "string",
"default": "-1"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrafficIncidentTileResult"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"500": {
"$ref": "#/responses/500"
}
},
"produces": [
"application/json"
]
}
},
"/traffic/incident/detail/{format}": {
"get": {
"x-publish": true,
"description": "__Traffic Incident Detail__ \n\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\nThis API provides information on traffic incidents inside a given bounding box, based on the current Traffic Model ID. The Traffic Model ID is available to grant synchronization of data between calls and API's. The Traffic Model ID is a key value for determining the currency of traffic incidents. It is updated every minute, and is valid for two minutes before it times out. It is used in rendering [incident tiles](https://docs.microsoft.com/en-us/rest/api/maps/traffic/gettrafficincidenttile). It can be obtained from the [Viewport API](https://docs.microsoft.com/en-us/rest/api/maps/traffic/gettrafficincidentviewport).",
"operationId": "Traffic_GetTrafficIncidentDetail",
"x-ms-examples": {
"GetTrafficIncidentDetail": {
"$ref": "./examples/GetTrafficIncidentDetail.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ClientId"
},
{
"$ref": "#/parameters/SubscriptionKey"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/TextFormat"
},
{
"name": "style",
"in": "query",
"description": "The style that will be used to render the tile in Traffic [Incident Tile API](https://docs.microsoft.com/en-us/rest/api/maps/traffic/gettrafficincidenttile). This will have an effect on the coordinates of traffic incidents in the reply.",
"required": true,
"type": "string",
"enum": [
"s1",
"s2",
"s3",
"night"
],
"x-ms-enum": {
"name": "TrafficIncidentDetailStyle",
"modelAsString": true,
"values": [
{
"value": "s1",
"description": "Creates traffic lines with colored chevrons indicating severity."
},
{
"value": "s2",
"description": "Creates plain lines with certain degree of glow."
},
{
"value": "s3",
"description": "Creates plain lines with certain degree of glow."
},
{
"value": "night",
"description": "Night style."
}
]
}
},
{
"name": "boundingbox",
"in": "query",
"description": "The `boundingbox` is represented by two value pairs describing it's corners (first pair for lower left corner and second for upper right). The pairs can either be specified using any of the `projection`'s specified below (e.g., _minY,minX,maxY,maxX_) or by two latitude-longitude pairs (e.g., _minLat,minLon,maxLat,maxLon_).<br><br>NOTE: If latitude/longitude pairs are used, then the `projection` parameter must be set to \"EPSG4326\".",
"required": true,
"type": "string"
},
{
"name": "boundingZoom",
"in": "query",
"description": "Zoom level for desired tile. 0 to 22 for raster tiles, 0 through 22 for vector tiles",
"required": true,
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 22
},
{
"name": "trafficmodelid",
"in": "query",
"description": "Number referencing traffic model. This can be obtained from the [Viewport API](https://docs.microsoft.com/en-us/rest/api/maps/traffic/gettrafficincidentviewport). It is updated every minute, and is valid for two minutes before it times out. If the wrong Traffic Model ID is specified, the correct one will be returned by the interface. A value of -1 will always invoke the most recent traffic model",
"required": true,
"type": "string"
},
{
"name": "language",
"in": "query",
"description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the output language. Supported languages are ar, ca, cs, da, de, el, en, en-GB, en-US, es, et, fi, fr, he, hu, id, in*, it, lt, lv, nb, nl, no, pl, pt, ro, ru, sk, sv, th, tr, zh.\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details. When invalid language code is provided response is returned in English. When incident cause or description does not have translation, English description is returned.",
"required": false,
"type": "string"
},
{
"name": "projection",
"in": "query",
"description": "The projection used to specify the coordinates in the request and response. [EPSG900913](http://docs.openlayers.org/library/spherical_mercator.html) (default) or [EPSG4326](http://spatialreference.org/ref/epsg/4326/)",
"required": false,
"type": "string",
"enum": [
"EPSG900913",
"EPSG4326"
]
},
{
"name": "geometries",
"in": "query",
"description": "The type of vector geometry added to incidents (returned in the <v> element of the response).",
"required": false,
"type": "string",
"enum": [
"original",
"shifted"
],
"x-ms-enum": {
"name": "IncidentGeometryType",
"modelAsString": true,
"values": [
{
"value": "original",
"description": "Places incidents precisely on the road."
},
{
"value": "shifted",
"description": "Moves the incident slightly (depending on zoom level) to indicate specific road lanes."
}
]
}
},
{
"name": "expandCluster",
"in": "query",
"description": "Boolean to indicate whether to list all traffic incidents in a cluster separately",
"required": false,
"type": "boolean",
"default": false
},
{
"name": "originalPosition",
"in": "query",
"description": "Boolean on whether to return the original position of the incident (<op>) as well as the one shifted to the beginning of the traffic tube (<op>)",
"required": false,
"type": "boolean",
"default": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrafficIncidentDetailResult"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"500": {
"$ref": "#/responses/500"
}
}
}
},
"/traffic/incident/viewport/{format}": {
"get": {
"x-publish": true,
"description": "__Traffic Incident Viewport__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\nThis API returns legal and technical information for the viewport described in the request. It should be called by client applications whenever the viewport changes (for instance, through zooming, panning, going to a location, or displaying a route). The request should contain the bounding box and zoom level of the viewport whose information is needed. The return will contain map version information, as well as the current Traffic Model ID and copyright IDs. The Traffic Model ID returned by the Viewport Description is used by other APIs to retrieve last traffic information for further processing.",
"operationId": "Traffic_GetTrafficIncidentViewport",
"x-ms-examples": {
"GetTrafficIncidentViewport": {
"$ref": "./examples/GetTrafficIncidentViewport.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ClientId"
},
{
"$ref": "#/parameters/SubscriptionKey"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/TextFormat"
},
{
"name": "boundingbox",
"in": "query",
"description": "Bounding box of the map viewport in [EPSG900913](http://docs.openlayers.org/library/spherical_mercator.html) projection. The `boundingbox` is represented by two value pairs describing it's corners (first pair for lower left corner and second for upper right). All values should be separated by commas (e.g., _minY,minX,maxY,maxX_). The maximum size of the bounding box that can be passed is dependent on the requested zoom level. The width and height cannot exceed 4092 pixels when rendered on the given zoom level.<br><br>NOTE: Bounding boxes that cross the 180° meridian require special treatment. For such boxes, the eastern _maxX_ value will be negative, and thus less than the _minX_ value west of the 180° meridian. To address that, the value 40075016.6855874 should be added to the true _maxX_ value before it is passed in the request.",
"required": true,
"type": "string"
},
{
"name": "boundingzoom",
"in": "query",
"description": "Zoom level of the map viewport. Used to determine whether the view can be zoomed in.",
"required": true,
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 22
},
{
"name": "overviewbox",
"in": "query",
"description": "Bounding box of the overview map in [EPSG900913](http://docs.openlayers.org/library/spherical_mercator.html) projection.<br><br>Used in case the overview box/mini map has different copyright data than the main map. If there is no mini map, the same coordinates as `boundingBox` is used.",
"required": true,
"type": "string"
},
{
"name": "overviewzoom",
"in": "query",
"description": "Zoom level of the overview map. If there is no mini map, use the same zoom level as boundingZoom.",
"required": true,
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 22
},
{
"name": "copyright",
"in": "query",
"description": "Determines what copyright information to return. When true the copyright text is returned; when false only the copyright index is returned.",
"required": true,
"type": "boolean",
"default": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrafficIncidentViewportResult"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"500": {
"$ref": "#/responses/500"
}
}
}
}
},
"definitions": {
"ODataErrorResponse": {
"type": "object",
"description": "This response object is returned when an error occurs in the Maps API.",
"properties": {
"error": {
"$ref": "#/definitions/ODataError"
}
}
},
"ODataError": {
"type": "object",
"description": "This object is returned when an error occurs in the Maps API.",
"properties": {
"code": {
"type": "string",
"readOnly": true,
"description": "The ODataError code."
},
"message": {
"type": "string",
"readOnly": true,
"description": "If available, a human readable description of the error."
},
"details": {
"type": "array",
"items": {
"$ref": "#/definitions/ODataError"
}
},
"target": {
"type": "string",
"readOnly": true,
"description": "If available, the target causing the error."
}
}
},
"Coordinate": {
"description": "A location represented as a latitude and longitude.",
"type": "object",
"properties": {
"latitude": {
"description": "Latitude property",
"type": "number",
"format": "double",
"readOnly": true
},
"longitude": {
"description": "Longitude property",
"type": "number",
"format": "double",
"readOnly": true
}
}
},
"TrafficFlowTileResult": {
"description": "This image is returned from a successful Traffic Flow Tile call",
"type": "string",
"format": "binary",
"readOnly": true
},
"TrafficFlowSegmentResult": {
"description": "This object is returned from a successful Traffic Flow Segment call",
"type": "object",
"properties": {
"flowSegmentData": {
"description": "Flow Segment Data property",
"type": "object",
"readOnly": true,
"properties": {
"frc": {
"description": "Functional Road Class. This indicates the road type:\n 0: Motorway, freeway or other major road.\n 1: Major road, less important than a motorway.\n 2: Other major road.\n 3: Secondary road.\n 4: Local connecting road.\n 5: Local road of high importance.\n 6: Local road.",
"type": "string",
"readOnly": true
},
"currentSpeed": {
"description": "The current average speed at the selected point, in the units requested. This is calculated from the currentTravelTime and the length of the selected segment.",
"type": "integer",
"format": "int32",
"readOnly": true
},
"freeFlowSpeed": {
"description": "The free flow speed expected under ideal conditions, expressed in the units requested. This is related to the freeFlowTravelTime.",
"type": "integer",
"format": "int32",
"readOnly": true
},
"currentTravelTime": {
"description": "Current travel time in seconds based on fused real-time measurements between the defined locations in the specified direction.",
"type": "integer",
"format": "int32",
"readOnly": true
},
"freeFlowTravelTime": {
"description": "The travel time in seconds which would be expected under ideal free flow conditions.",
"type": "integer",
"format": "int32",
"readOnly": true
},
"confidence": {
"description": "The confidence is a measure of the quality of the provided travel time and speed. A value of 1 means full confidence, that the response contains the highest quality data. Lower values indicate the degree that the response may vary from the actual conditions on the road. Any value greater than 0.6 means the information was based on real-time probe input. A value of 0.5 means the reported speed is based on historical info. A value between 0.5 and 0.6 has a calculated weighted average between historical and live speeds.",
"type": "number",
"readOnly": true
},
"coordinates": {
"description": "Includes the coordinates describing the shape of the segment. Coordinates are shifted from the road depending on the zoom level to support high quality visualization in every scale.",
"type": "object",
"properties": {
"coordinate": {
"description": "Coordinate array",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/Coordinate"
}
}
}
},
"@version": {
"description": "This indicates the software version that generated the response.",
"type": "string",
"readOnly": true
},
"openlr": {
"description": "OpenLR code for segment",
"type": "number",
"readOnly": true
}
}
}
}
},
"TrafficIncidentTileResult": {
"description": "This object is returned from a successful Traffic Incident Tile call",
"type": "object",
"properties": {
"image": {
"description": "Image property",
"type": "string",
"readOnly": true
}
}
},
"TrafficIncidentDetailResult": {
"description": "This object is returned from a successful Traffic incident Detail call",
"type": "object",
"properties": {
"tm": {
"description": "Main response element",
"type": "object",
"readOnly": true,
"properties": {
"@id": {
"description": "ID of the traffic incident",
"type": "string",
"readOnly": true
},
"poi": {
"description": "A single traffic incident, or a cluster of traffic incidents",
"type": "array",
"readOnly": true,